Global Index
HTML5 JS API Index > SVG Tutorials & Specs

SVGLength

The SVGLength interface corresponds to the <length> basic data type.

Properties
const unsigned short
SVG_LENGTHTYPE_CM = 6
A value was specified using the cm units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_EMS = 3
A value was specified using the em units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_EXS = 4
A value was specified using the ex units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_IN = 8
A value was specified using the in units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_MM = 7
A value was specified using the mm units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_NUMBER = 1
No unit type was provided (i.e., a unitless value was specified), which indicates a value in user units.
const unsigned short
SVG_LENGTHTYPE_PC = 10
A value was specified using the pc units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_PERCENTAGE = 2
A percentage value was specified.
const unsigned short
SVG_LENGTHTYPE_PT = 9
A value was specified using the pt units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_PX = 5
A value was specified using the px units defined in CSS2.
const unsigned short
SVG_LENGTHTYPE_UNKNOWN = 0
The unit type is not one of predefined unit types. It is invalid to attempt to define a new value of this type or to attempt to switch an existing value to this type.
unsigned short
unitType
The type of the value as specified by one of the SVG_LENGTHTYPE_* constants defined on this interface.
float
value
The value of the given attribute. Exceptions on settingDOMException, code NO_MODIFICATION_ALLOWED_ERR Raised on an attempt to change the value of a read only attribute.
DOMString
valueAsString
The value as a string value, in the units expressed by unitType. Setting this attribute will cause value, valueInSpecifiedUnits and unitType to be updated automatically to reflect this setting. Exceptions on settingDOMException, code SYNTAX_ERR Raised if the assigned string cannot be parsed as a valid <length>.
float
valueInSpecifiedUnits
The value as a floating point value, in the units expressed by unitType. Setting this attribute will cause value and valueAsString to be updated automatically to reflect this setting. Exceptions on settingDOMException, code NO_MODIFICATION_ALLOWED_ERR Raised when the length corresponds to a read only attribute or when the object itself is read only.
Operations
void
convertToSpecifiedUnits(unsigned short unitType)
Preserve the same underlying stored value, but reset the stored unit identifier to the given unitType. Object attributes unitType, valueInSpecifiedUnits and valueAsString might be modified as a result of this method. For example, if the original value were "0.5cm" and the method was invoked to convert to millimeters, then the unitType would be changed to SVG_LENGTHTYPE_MM, valueInSpecifiedUnits would be changed to the numeric value 5 and valueAsString would be changed to "5mm".
void
newValueSpecifiedUnits(unsigned short unitType, float valueInSpecifiedUnits)
Reset the value as a number with an associated unitType, thereby replacing the values for all of the attributes on the object. Parametersunsigned short unitType The unit type for the value (e.g., SVG_LENGTHTYPE_MM). float valueInSpecifiedUnits The new value.
Referenced by
SVGAnimatedLengthbaseVal
SVGLengthListreplaceItem(...)
SVGSVGElementcreateSVGLength()